home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / bbsutil / mbu_110.zip / MBUTIL.DOC < prev    next >
Text File  |  1990-05-26  |  37KB  |  975 lines
  1.  
  2.  
  3.      MBUTIL - RemoteAccess/QuickBBS Message Base Utility 1.10
  4.      Copyright (C) 1990 Gerard van der Land. All rights reserved.
  5.  
  6.  
  7.  
  8.      Features
  9.      --------
  10.  
  11.      * Sorting messages by board and post date and time
  12.      * Purging messages by number, date or received status
  13.      * Message base packing with AutoRenumber
  14.      * Reply chain linking and subject cleaning
  15.      * Creating index files and fixing all kinds of problems and errors
  16.      * Undeleting deleted messages
  17.      * Moving all messages in one board to another board
  18.      * Posting a file as a message
  19.      * Netmail Import .MSG ==> MSG*.BBS
  20.      * Netmail Export MSG*.BBS ==> .MSG (updates credit)
  21.      * Replacing up to 5 different tearlines in outgoing echomail messages
  22.      * Creating 'Outbound Traffic Report'
  23.      * Build-in help screens for all commands
  24.      * It  does  NOT require  a  specific  BBS program,  mailer  or message
  25.        editor, as it uses its own control file and environment variable
  26.      * Writes logfile in  FrontDoor, Opus,  D'Bridge, Binkley and  QuickBBS
  27.        format
  28.  
  29.  
  30.  
  31.      Disclaimer, License and Other Important Stuff
  32.      ---------------------------------------------
  33.  
  34.            The following points  must be considered, understood  and agreed
  35.      upon BEFORE you use MBUTIL 1.10:
  36.  
  37.      * MBUTIL is distributed  as ShareWare, and  not as FreeWare or  Public
  38.        Domain!
  39.  
  40.      * This  documentation  and  the accompanying  program  is  copyrighted
  41.        material by Gerard van der Land.
  42.  
  43.      * Although care  has been taken to write and  test a program that does
  44.        what this documentation  states, the program  is provided as it  is,
  45.        without  warranty or  guarantee  of any  kind,  either expressed  or
  46.        implied, as to  the quality or  performance of this program,  except
  47.        that it will occupy disk space.
  48.  
  49.      * The author will not be held liable to you or anyone for  any direct,
  50.        indirect, incidental  or consequential  damages, including any  lost
  51.        profits, lost savings which may result  from the use or inability to
  52.        use this program.
  53.        Your  use  of   the  program  constitutes  your  agreement  to  this
  54.        disclaimer and your release of the author from any form of liability
  55.        or litigation.
  56.  
  57.      * You  are granted  limited license  to use  MBUTIL 1.10  and you  are
  58.        encouraged to copy and distribute it in an unmodified way as much as
  59.        you want, as  long as you  still abide to  the conditions  mentioned
  60.        here and no money or other compensation is asked or accepted.
  61.  
  62.                                         1
  63.  
  64.      System Hardware and Software Requirements
  65.      -----------------------------------------
  66.  
  67.      * An IBM PC, XT, AT or 100% compatible.
  68.      * The amount  of RAM  that should  be available  very much  depends on
  69.        which command you  are using and how  big your message base  is, but
  70.        around 300 KB should  be enough in most  cases. If you run  it under
  71.        DoubleDOS/DesqView,  just   try.  If   there's  not   enough  memory
  72.        available, MBUTIL will certainly let you know!
  73.      * Microsoft  MS-DOS  3.00  / IBM  PC-DOS  3.00  or  above. MBUTIL  was
  74.        successfully tested under MS-DOS 4.01.
  75.      * At least "FILES=15" (or more) in your CONFIG.SYS.
  76.      * A RemoteAccess ≤ 0.0x or QuickBBS 2.xx compatible message base.
  77.  
  78.  
  79.  
  80.      Setup
  81.      -----
  82.  
  83.            Before you use MBUTIL  you should enter your information  in the
  84.      control file MBUTIL.CTL using an ASCII text editor. Explanation of the
  85.      keywords is given there.
  86.  
  87.  
  88.  
  89.      Environment Variable
  90.      --------------------
  91.  
  92.      Usage:
  93.  
  94.         SET MBU=<controfile> [<color>]
  95.  
  96.            To be able to run MBUTIL from any directory, you can use the MBU
  97.      environment variable. If  MBUTIL can't find MBUTIL.CTL  in the current
  98.      path, it will try the open the filename set with MBU. This can also be
  99.      useful for people having  more than one message base, who  can use SET
  100.      to select from their batch file which control file should be used.
  101.  
  102.            <color> is optional and is the default text color, which is also
  103.      used  if  the  control file  was  found  in the  current  path.  It is
  104.      calculated as follows:
  105.  
  106.         <foreground color> + (16 * <background color>)
  107.  
  108.      Colors:
  109.  
  110.         0    Black                4    Red
  111.         1    Blue                 5    Magenta
  112.         2    Green                6    Yellow
  113.         3    Cyan                 7    White
  114.  
  115.            Add 8 for highlighted foreground colors. <color> is 7 by default
  116.      (White text on a Black background).
  117.  
  118.      Example:
  119.  
  120.         SET MBU=C:\RA\MBUTIL.CTL 3
  121.  
  122.  
  123.                                         2
  124.  
  125.      Specifying Boards
  126.      -----------------
  127.  
  128.            If you must specify a  <board>, you can use the area tag (if you
  129.      have specified an AreasFile in the control file), or #<boardnumber>.
  130.  
  131.            A special fixed area name is  "NETMAIL", which will always refer
  132.      to your NetmailBoard, if defined.
  133.  
  134.  
  135.  
  136.      Help Screens
  137.      ------------
  138.  
  139.            If you run 'MBUTIL', you will see the following help screen:
  140.  
  141.      +-------------------------------------------------------------------+
  142.      | MBUTIL - RemoteAccess/QuickBBS Message Base Utility 1.10          |
  143.      | Copyright (C) 1990 Gerard van der Land. All rights reserved.      |
  144.      |                                                                   |
  145.      | Usage:                                                            |
  146.      |                                                                   |
  147.      |    MBUTIL <command> [<parameters>]                                |
  148.      |                                                                   |
  149.      | Commands:                                                         |
  150.      |                                                                   |
  151.      |    Export      Export netmail messages and replace tearlines      |
  152.      |    Import      Import netmail messages                            |
  153.      |    Index       Create new index files                             |
  154.      |    Link        Create reply chains and clean subjects             |
  155.      |    Move        Move messages in one board to another board        |
  156.      |    Pack        Pack the message base files                        |
  157.      |    Post        Post a file as message in a specified board        |
  158.      |    Purge       Delete messages according to age or number         |
  159.      |    Sort        Sort unread or all messages by board/date/time     |
  160.      |    Undelete    Undelete deleted messages                          |
  161.      |                                                                   |
  162.      | Run 'MBUTIL <command> ?' to get information about <parameters>.   |
  163.      |                                                                   |
  164.      | C:\RA>_                                                           |
  165.      |                                                                   |
  166.      +-------------------------------------------------------------------+
  167.  
  168.      Example:
  169.  
  170.         MBUTIL Purge ?
  171.  
  172.            This will give you  information about the Purge command  and its
  173.      parameters. If a  parameter is  missing or invalid,  MBUTIL will  also
  174.      show you a help screen.
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.                                         3
  185.  
  186.      Sort
  187.      ----
  188.  
  189.      Usage:
  190.  
  191.         MBUTIL Sort [-All] [-Backup] [-Pack]
  192.  
  193.              The Sort command can  be used to  sort all unread messages  by
  194.        board number and post date and time. This has two advantages:
  195.  
  196.           + When using combined read mode to read new messages for example,
  197.             you won't see messages from different boards mixed up.
  198.           + It reduces the chance that you read a reply to a message before
  199.             you  actually  read the  message  that  was  replied to,  which
  200.             happened pretty often to  me and which was actually  the reason
  201.             why I started  writing MB